xportethxe 2.2.1
Loading...
Searching...
No Matches
xportethxe.h File Reference

This file contains API for XPort ETH XE Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  xportethxe_t
 XPort ETH XE Click context object. More...
struct  xportethxe_cfg_t
 XPort ETH XE Click configuration object. More...

Macros

#define XPORTETHXE_CMD_MODE_CONFIG   "xxx"
 XPort ETH XE control commands.
#define XPORTETHXE_CMD_MODE_MONITOR   "yyy"
#define XPORTETHXE_CMD_MODE_MONITOR_WITH_NET   "zzz"
#define XPORTETHXE_CMD_ENTER   "\r"
#define XPORTETHXE_CMD_AT   "AT"
#define XPORTETHXE_CMD_SET_IP   "co"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_0   "G0"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_1   "G1"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_2   "G2"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_3   "G3"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_4   "G4"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_5   "G5"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_6   "G6"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_7   "G7"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_8   "G8"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_9   "G9"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_A   "Ga"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_B   "Gb"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_C   "Gc"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_D   "Gd"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_E   "Ge"
#define XPORTETHXE_CMD_GET_MEM_PAGE_CONFIG_F   "Gf"
#define XPORTETHXE_CMD_GET_IP_CONFIG(ADR)
#define XPORTETHXE_CMD_GET_MAC_ADDRESS   "GM"
#define XPORTETHXE_CMD_NET_CONN   "NC"
#define XPORTETHXE_CMD_NET_STAT   "NS"
#define XPORTETHXE_CMD_PING(ADR)
#define XPORTETHXE_CMD_QUIT   "QU"
#define XPORTETHXE_CMD_RESET   "RS"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_0   "S0"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_1   "S1"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_2   "S2"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_3   "S3"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_4   "S4"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_5   "S5"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_6   "S6"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_7   "S7"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_8   "S8"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_9   "S9"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_A   "Sa"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_B   "Sb"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_C   "Sc"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_D   "Sd"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_E   "Se"
#define XPORTETHXE_CMD_SET_MEM_PAGE_CONFIG_F   "Sf"
#define XPORTETHXE_CMD_SCAN   "SA"
#define XPORTETHXE_CMD_SEND_CONFIG(ADR)
#define XPORTETHXE_CMD_SET_SECURITY_RECORD   "SS"
#define XPORTETHXE_CMD_SET_SECURITY_RECORD   "SS"
#define XPORTETHXE_CMD_TCP_CONN_TABLE   "TT"
#define XPORTETHXE_CMD_QUERY_FW_VERSION   "VN"
#define XPORTETHXE_CMD_VERSION(ADR)
#define XPORTETHXE_CMD_FLASH_WRITE_COUNT   "WC"
#define XPORTETHXE_RSP_OK   "0>"
 XPort ETH XE response commands.
#define XPORTETHXE_RSP_NO_ANSWER   "1>"
#define XPORTETHXE_RSP_NO_REACH   "2>"
#define XPORTETHXE_RSP_WRONG_PAR   "8>"
#define XPORTETHXE_RSP_INVALID_CMD   "9>"
#define XPORTETHXE_TX_DRV_BUFFER_SIZE   200
 XPort ETH XE driver buffer size.
#define XPORTETHXE_RX_DRV_BUFFER_SIZE   1000
#define XPORTETHXE_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  xportethxe_return_value_t { XPORTETHXE_OK = 0 , XPORTETHXE_ERROR = -1 , XPORTETHXE_ERROR_TIMEOUT = -2 , XPORTETHXE_ERROR_CMD = -3 }
 XPort ETH XE Click return value data. More...

Functions

void xportethxe_cfg_setup (xportethxe_cfg_t *cfg)
 XPort ETH XE configuration object setup function.
err_t xportethxe_init (xportethxe_t *ctx, xportethxe_cfg_t *cfg)
 XPort ETH XE initialization function.
err_t xportethxe_generic_write (xportethxe_t *ctx, uint8_t *data_in, uint16_t len)
 XPort ETH XE data writing function.
err_t xportethxe_generic_read (xportethxe_t *ctx, uint8_t *data_out, uint16_t len)
 XPort ETH XE data reading function.
void xportethxe_send_cmd (xportethxe_t *ctx, uint8_t *cmd)
 XPort ETH XE send cmd function.
void xportethxe_send_enter (xportethxe_t *ctx)
 XPort ETH XE send enter function.
void xportethxe_set_rst_pin (xportethxe_t *ctx, uint8_t state)
 XPort ETH XE set RST pin function.
void xportethxe_set_cts_pin (xportethxe_t *ctx, uint8_t state)
 XPort ETH XE set CTS pin function.
uint8_t xportethxe_get_rts_pin (xportethxe_t *ctx)
 XPort ETH XE get RTS pin function.
uint8_t xportethxe_get_dtr_pin (xportethxe_t *ctx)
 XPort ETH XE get DTR pin function.
void xportethxe_reset_device (xportethxe_t *ctx)
 XPort ETH XE reset device function.

Detailed Description

This file contains API for XPort ETH XE Click Driver.

Enumeration Type Documentation

◆ xportethxe_return_value_t

XPort ETH XE Click return value data.

Predefined enum values for driver return values.

Enumerator
XPORTETHXE_OK 
XPORTETHXE_ERROR 
XPORTETHXE_ERROR_TIMEOUT 
XPORTETHXE_ERROR_CMD